Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix async_scanner_devices_by_address unexpectedly combining Bluetooth scanners #94990

Merged
merged 3 commits into from
Jun 22, 2023

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Jun 21, 2023

Proposed change

Since _get_scanners_by_type returned the scanners without making a copy, async_scanner_devices_by_address would extend the list of scanners and unexpectedly add the non-connectable ones to the connectable list.

Refactor to remove the _get_X_by_type functions to avoid this pattern

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Black (black --fast homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

Since _get_scanners_by_type returned the scanners without making a copy,
async_scanner_devices_by_address would extend the list of scanners and
unexpectedly add the non-connectable ones to the connectable list.

Refactor to remove the _get_X_by_type functions to avoid this
pattern
@bdraco bdraco marked this pull request as ready for review June 21, 2023 12:45
@bdraco bdraco changed the title Fix async_scanner_devices_by_address unexpectedly combining scanners Fix async_scanner_devices_by_address unexpectedly combining Bluetooth scanners Jun 21, 2023
@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jun 22, 2023
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @bdraco 👍

../Frenck

@frenck frenck merged commit 1459bf4 into dev Jun 22, 2023
@frenck frenck deleted the async_scanner_devices_by_address_fix branch June 22, 2023 14:50
@bdraco
Copy link
Member Author

bdraco commented Jun 22, 2023

Thanks.

@github-actions github-actions bot locked and limited conversation to collaborators Jun 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants